/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package edu.ccut.titan.component;

import java.util.List;

/**
 * Record a component base information.
 * <p>
 * All component type information must implement this information
 * 
 * @author LeslieGu
 * 
 */
public interface IComponentInfo {

	public static final String KEY_SEPARATOR = "::";

	/**
	 * Get unique key.
	 * 
	 * @return
	 */
	public String getKey();

	/**
	 * Get symbolic name of bundle where the component in.
	 * 
	 * @return
	 */
	public String getBundleSymbolicName();

	/**
	 * Get complete Key. key = getBundleSymbolicName() + "::" + getKey()
	 * 
	 * @return
	 */
	public String getFullKey();

	/**
	 * Get component name
	 * 
	 * @return
	 */
	public String getName();

	/**
	 * Get component description
	 * 
	 * @return
	 */
	public String getDescription();

	/**
	 * Get {@link IParameterInfo} List
	 * 
	 * @return
	 */
	public List<IParameterInfo> getParameterInfos();

	/**
	 * Create a component
	 * 
	 * @return
	 * @throws TitanComponentException
	 */
	public IComponent createComponent() throws TitanComponentException;
}
